home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / Hash.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  9.3 KB  |  230 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/Hash.3,v 1.9 93/07/23 08:30:53 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) Hash.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_Hash tclc
  32. .BS
  33. .SH NAME
  34. .na
  35. Tcl_InitHashTable, Tcl_DeleteHashTable, Tcl_CreateHashEntry, Tcl_DeleteHashEntry, Tcl_FindHashEntry, Tcl_GetHashValue, Tcl_SetHashValue, Tcl_GetHashKey, Tcl_FirstHashEntry, Tcl_NextHashEntry, Tcl_HashStats \- procedures to manage hash tables
  36. .SH SYNOPSIS
  37. .nf
  38. \fB#include <tcl.h>\fR
  39. .sp
  40. \fBTcl_InitHashTable\fR(\fItablePtr, keyType\fR)
  41. .sp
  42. \fBTcl_DeleteHashTable\fR(\fItablePtr\fR)
  43. .sp
  44. Tcl_HashEntry *
  45. \fBTcl_CreateHashEntry\fR(\fItablePtr, key, newPtr\fR)
  46. .sp
  47. \fBTcl_DeleteHashEntry\fR(\fIentryPtr\fR)
  48. .sp
  49. Tcl_HashEntry *
  50. \fBTcl_FindHashEntry\fR(\fItablePtr, key\fR)
  51. .sp
  52. ClientData
  53. \fBTcl_GetHashValue\fR(\fIentryPtr\fR)
  54. .sp
  55. \fBTcl_SetHashValue\fR(\fIentryPtr, value\fR)
  56. .sp
  57. char *
  58. \fBTcl_GetHashKey\fR(\fItablePtr, entryPtr\fR)
  59. .sp
  60. Tcl_HashEntry *
  61. \fBTcl_FirstHashEntry\fR(\fItablePtr, searchPtr\fR)
  62. .sp
  63. Tcl_HashEntry *
  64. \fBTcl_NextHashEntry\fR(\fIsearchPtr\fR)
  65. .sp
  66. char *
  67. \fBTcl_HashStats\fR(\fItablePtr\fR)
  68. .SH ARGUMENTS
  69. .AS Tcl_HashSearch *searchPtr
  70. .AP Tcl_HashTable *tablePtr in
  71. Address of hash table structure (for all procedures but
  72. \fBTcl_InitHashTable\fR, this must have been initialized by
  73. previous call to \fBTcl_InitHashTable\fR).
  74. .AP int keyType in
  75. Kind of keys to use for new hash table.  Must be either
  76. TCL_STRING_KEYS, TCL_ONE_WORD_KEYS, or an integer value
  77. greater than 1.
  78. .AP char *key in
  79. Key to use for probe into table.  Exact form depends on
  80. \fIkeyType\fR used to create table.
  81. .AP int *newPtr out
  82. The word at \fI*newPtr\fR is set to 1 if a new entry was created
  83. and 0 if there was already an entry for \fIkey\fR.
  84. .AP Tcl_HashEntry *entryPtr in
  85. Pointer to hash table entry.
  86. .AP ClientData value in
  87. New value to assign to hash table entry.  Need not have type
  88. ClientData, but must fit in same space as ClientData.
  89. .AP Tcl_HashSearch *searchPtr in
  90. Pointer to record to use to keep track of progress in enumerating
  91. all the entries in a hash table.
  92. .BE
  93.  
  94. .SH DESCRIPTION
  95. .PP
  96. A hash table consists of zero or more entries, each consisting of
  97. a key and a value.
  98. Given the key for an entry, the hashing routines can very quickly
  99. locate the entry, and hence its value.
  100. There may be at most one entry in a hash table with a
  101. particular key, but many entries may have the same value.
  102. Keys can take one of three forms:  strings,
  103. one-word values, or integer arrays.
  104. All of the keys in a given table have the same form, which is
  105. specified when the table is initialized.
  106. .PP
  107. The value of a hash table entry can be anything that fits in
  108. the same space as a ``char *'' pointer.
  109. Values for hash table entries are managed entirely by clients,
  110. not by the hash module itself.
  111. Typically each entry's value is a pointer to a data structure
  112. managed by client code.
  113. .PP
  114. Hash tables grow gracefully as the number of entries increases,
  115. so that there are always less than three entries per hash bucket,
  116. on average.
  117. This allows for fast lookups regardless of the number of entries
  118. in a table.
  119. .PP
  120. \fBTcl_InitHashTable\fR initializes a structure that describes
  121. a new hash table.
  122. The space for the structure is provided by the caller, not by
  123. the hash module.
  124. The value of \fIkeyType\fR indicates what kinds of keys will
  125. be used for all entries in the table.  \fIKeyType\fR must have
  126. one of the following values:
  127. .IP \fBTCL_STRING_KEYS\fR 25
  128. Keys are null-terminated ASCII strings.
  129. They are passed to hashing routines using the address of the
  130. first character of the string.
  131. .IP \fBTCL_ONE_WORD_KEYS\fR 25
  132. Keys are single-word values;  they are passed to hashing routines
  133. and stored in hash table entries as ``char *'' values.
  134. The pointer value is the key;  it need not (and usually doesn't)
  135. actually point to a string.
  136. .IP \fIother\fR 25
  137. If \fIkeyType\fR is not TCL_STRING_KEYS or TCL_ONE_WORD_KEYS,
  138. then it must be an integer value greater than 1.
  139. In this case the keys will be arrays of ``int'' values, where
  140. \fIkeyType\fR gives the number of ints in each key.
  141. This allows structures to be used as keys.
  142. All keys must have the same size.
  143. Array keys are passed into hashing functions using the address
  144. of the first int in the array.
  145. .PP
  146. \fBTcl_DeleteHashTable\fR deletes all of the entries in a hash
  147. table and frees up the memory associated with the table's
  148. bucket array and entries.
  149. It does not free the actual table structure (pointed to
  150. by \fItablePtr\fR), since that memory is assumed to be managed
  151. by the client.
  152. \fBTcl_DeleteHashTable\fR also does not free or otherwise
  153. manipulate the values of the hash table entries.
  154. If the entry values point to dynamically-allocated memory, then
  155. it is the client's responsibility to free these structures
  156. before deleting the table.
  157. .PP
  158. \fBTcl_CreateHashEntry\fR locates the entry corresponding to a
  159. particular key, creating a new entry in the table if there
  160. wasn't already one with the given key.
  161. If an entry already existed with the given key then \fI*newPtr\fR
  162. is set to zero.
  163. If a new entry was created, then \fI*newPtr\fR is set to a non-zero
  164. value and the value of the new entry will be set to zero.
  165. The return value from \fBTcl_CreateHashEntry\fR is a pointer to
  166. the entry, which may be used to retrieve and modify the entry's
  167. value or to delete the entry from the table.
  168. .PP
  169. \fBTcl_DeleteHashEntry\fR will remove an existing entry from a
  170. table.
  171. The memory associated with the entry itself will be freed, but
  172. the client is responsible for any cleanup associated with the
  173. entry's value, such as freeing a structure that it points to.
  174. .PP
  175. \fBTcl_FindHashEntry\fR is similar to \fBTcl_CreateHashEntry\fR
  176. except that it doesn't create a new entry if the key doesn't exist;
  177. instead, it returns NULL as result.
  178. .PP
  179. \fBTcl_GetHashValue\fR and \fBTcl_SetHashValue\fR are used to
  180. read and write an entry's value, respectively.
  181. Values are stored and retrieved as type ``ClientData'', which is
  182. large enough to hold a pointer value.  On almost all machines this is
  183. large enough to hold an integer value too.
  184. .PP
  185. \fBTcl_GetHashKey\fR returns the key for a given hash table entry,
  186. either as a pointer to a string, a one-word (``char *'') key, or
  187. as a pointer to the first word of an array of integers, depending
  188. on the \fIkeyType\fR used to create a hash table.
  189. In all cases \fBTcl_GetHashKey\fR returns a result with type
  190. ``char *''.
  191. When the key is a string or array, the result of \fBTcl_GetHashKey\fR
  192. points to information in the table entry;  this information will
  193. remain valid until the entry is deleted or its table is deleted.
  194. .PP
  195. \fBTcl_FirstHashEntry\fR and \fBTcl_NextHashEntry\fR may be used
  196. to scan all of the entries in a hash table.
  197. A structure of type ``Tcl_HashSearch'', provided by the client,
  198. is used to keep track of progress through the table.
  199. \fBTcl_FirstHashEntry\fR initializes the search record and
  200. returns the first entry in the table (or NULL if the table is
  201. empty).
  202. Each susequent call to \fBTcl_NextHashEntry\fR returns the
  203. next entry in the table or
  204. NULL if the end of the table has been reached.
  205. A call to \fBTcl_FirstHashEntry\fR followed by calls to
  206. \fBTcl_NextHashEntry\fR will return each of the entries in
  207. the table exactly once, in an arbitrary order.
  208. It is unadvisable to modify the structure of the table, e.g.
  209. by creating or deleting entries, while the search is in
  210. progress.
  211. .PP
  212. \fBTcl_HashStats\fR returns a dynamically-allocated string with
  213. overall information about a hash table, such as the number of
  214. entries it contains, the number of buckets in its hash array,
  215. and the utilization of the buckets.
  216. It is the caller's responsibility to free the result string
  217. by passing it to \fBfree\fR.
  218. .PP
  219. The header file \fBtcl.h\fR defines the actual data structures
  220. used to implement hash tables.
  221. This is necessary so that clients can allocate Tcl_HashTable
  222. structures and so that macros can be used to read and write
  223. the values of entries.
  224. However, users of the hashing routines should never refer directly
  225. to any of the fields of any of the hash-related data structures;
  226. use the procedures and macros defined here.
  227.  
  228. .SH KEYWORDS
  229. hash table, key, lookup, search, value
  230.